Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
@stdlib/utils-library-manifest
Advanced tools
Readme
Load a manifest for compiling source files.
npm install @stdlib/utils-library-manifest
var manifest = require( '@stdlib/utils-library-manifest' );
Loads a manifest for compiling source files.
var conditions = {
'os': 'linux'
};
var conf = manifest( './examples/manifest.json', conditions );
// returns <Object>
The function accepts the following options
:
'win32'
, 'mixed'
, or 'posix'
. Default: based on host platform.The default search directory is the current working directory of the calling process. To specify an alternative search directory, set the basedir
option.
var conditions = {
'os': 'linux'
};
var opts = {
'basedir': __dirname
};
var conf = manifest( './examples/manifest.json', conditions, opts );
// returns <Object>
A manifest is a JSON file having the following fields:
options: an object
containing key-value pairs. Each key corresponds to a field in confs and may be used to conditionally select a configuration. Each value corresponds to the key's default value. The value for each field in a provided conditions
object which has a corresponding field in options overrides the default value.
Option keys are akin to primary keys in relational databases, in the sense that they should be used to uniquely identify a particular configuration. While individual key values may be shared across configurations, each configuration should have a unique combination of key values. Furthermore, default option values considered as a unique set should identify one and only one default configuration.
fields: an object array
where each object
has the following fields:
boolean
indicating whether to resolve field values as file paths. If true
, all field values are resolved relative to the manifest file.boolean
indicating whether to resolve field values as relative file paths. This field is only considered when a manifest is a root manifest. If true
, all field values, including those originating from dependencies, are resolved as relative file paths relative the root manifest.confs: an object array
where each object
corresponds to a manifest configuration. Each object
has the following fields:
array
of source files.array
of include directories.array
of linked library dependencies.array
of linked library paths.array
of package dependencies containing source files.An example manifest:
{
"options": {
"os": "linux"
},
"fields": [
{
"field": "src",
"resolve": true,
"relative": true
},
{
"field": "include",
"resolve": true,
"relative": false
},
{
"field": "libraries",
"resolve": false,
"relative": false
},
{
"field": "libpath",
"resolve": true,
"relative": false
}
],
"confs": [
{
"os": "linux",
"src": [
"./src/foo_linux.f",
"./src/foo_linux.c"
],
"include": [
"./include"
],
"libraries": [],
"libpath": [],
"dependencies": [
"@stdlib/blas/base/daxpy",
"@stdlib/blas/base/dasum",
"@stdlib/blas/base/dcopy"
]
}
]
}
The function recursively walks the manifest dependency tree to resolve all source files, libraries, library paths, and include directories.
An input filepath
may be either a relative or absolute file path. If provided a relative file path, a manifest is resolved relative to the base search directory.
If a conditions
object contains fields which do not correspond to manifest options, those fields are ignored (i.e., the "extra" fields have no effect when filtering manifest configurations). This allows providing a conditions
object containing fields which only apply to certain subsets of manifest dependencies.
If no fields in a conditions
object have corresponding fields in a manifest's options, the function returns a manifest's default configuration.
var join = require( 'path' ).join;
var manifest = require( '@stdlib/utils-library-manifest' );
// Resolve the absolute path of the manifest JSON file:
var fpath = join( __dirname, 'examples', 'manifest.json' );
// Specify conditions for determining which configuration to load:
var conditions = {
'os': 'mac'
};
// Specify options:
var opts = {
'basedir': __dirname
};
// Load a manifest configuration:
var conf = manifest( fpath, conditions, opts );
console.dir( conf );
To use the module as a general utility, install the module globally
npm install -g @stdlib/utils-library-manifest
Usage: library-manifest [options] <filepath> [-- --<condition>=value ...]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--dir basedir Base search directory.
--paths convention Path convention.
--
separator.$ library-manifest ./examples/manifest.json -- --os mac
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.
FAQs
Load a manifest for compiling source files.
We found that @stdlib/utils-library-manifest demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).